home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 20 / Cream of the Crop 20 (Terry Blount) (1996).iso / bbs / msrch11.zip / MULTSRCH.DOC < prev    next >
Text File  |  1996-07-07  |  21KB  |  416 lines
  1.                     Documentation for MultiSearch Text Door
  2.                          Written by Robert V. Chambers
  3.                                Copyright (c) 1996
  4.  
  5.  
  6. WHAT IS MULTISEARCH TEXT DOOR?
  7. MultiSearch Text Door is a BBS door program that will let you, the sysop, make
  8. text  files  available  to  your users  for  on-line  viewing,  searching, and
  9. downloading.  Sounds  dull, right? Well, there's  a  catch. This door makes it
  10. possible  to not only view a file but to also search for text within the file.
  11. And not just within one file, either. With MultiSearch Text Door you can elect
  12. to  search across any files that are  available and display the results a page
  13. at  a  time,  or only display the  lines  that  meet the search criteria. Just
  14. select  the  files of interest, enter text to  search for, and let it go. It's
  15. the   perfect   utility  door  for  scanning   your  log  files,  making  game
  16. documentation  or  faq sheets available, etc.  MultiSearch  Text Door makes it
  17. extremely  easy  to access the information you  and  your users want and need.
  18. With DSZ your user can download any file that he/she has clearance to view.
  19.  
  20. The  door  provides  ANSI graphics file capability  so  that you can make your
  21. favorite  ANSIs  available to your users,  thus extending the functionality of
  22. the  door.  Though  the primary function  is  text reading and searching, this
  23. feature was added at the encouragement of the beta testers.
  24.  
  25. While  most  doors  are aimed at either the  user  or the sysop, this one will
  26. benefit both.
  27.  
  28. SYSTEM REQUIREMENTS:
  29. 386 or better processor
  30. 220K memory (probably less, just being conservative).
  31.  
  32. WHAT ARE SOME OF THE FEATURES?
  33. *  Search multiple files for information.
  34. *  Display ANSI graphics files.
  35. *  Up to 225 files can be made available. (Registered only)
  36. *  Download files of interest. (Requires DSZ)
  37. *  Up to 20 document categories.
  38. *  Optional activity log.
  39. *  On-line help.
  40. *  Simple Boolean search patterns.
  41. *  Page numbering.
  42. *  Displays file size and date.
  43. *  File-specific security clearance.
  44. *  Custom color configuration of file and category menus.
  45. *  Comes complete with menu editor for adding or removing documents.
  46. *  Has a sysop chat mode.
  47. *  Fossil aware.
  48. *  Supports   standard   drop  files   such   as  DOOR.SYS  (PCBoard/GAP),
  49.    DORINFO1.DEF, EXITINFO.BBS, CHAIN.TXT, etc.
  50. *  Supports multiple nodes.
  51. *  Includes an editor to make menu maintenance a snap.
  52. *  These are the basics, but there's lots more!
  53.  
  54. LIMITATIONS ON UNREGISTERED VERSION:
  55. The  unregistered version will only support 10 documents in the menu. You must
  56. register  the  program  to  eliminate this  restriction.  See  the  section on
  57. registration below.
  58.  
  59. WHERE ARE THE INSTRUCTIONS ON USAGE?
  60. All  instructions on how to use the door once it has been installed are in the
  61. on-line  help file. If you can't wait, and  want to read it now, the help file
  62. is  called "multsrch.hlp". Be careful that  you don't inadvertently change the
  63. wording  in  the file, since this is the  one  that will be displayed when the
  64. user  enters on-line help! Of course, you are free to edit it if you wish, and
  65. may even like to add some additional information.
  66.  
  67. HOW DO I INSTALL IT:
  68. This is simple, but you must follow these instructions. I am assuming that you
  69. are already familiar with the steps required to install a door on your BBS. If
  70. not,  I  would  suggest  that you read  your  manual  first. This doc will not
  71. attempt to guide you through that.
  72.  
  73. Step  1) Unzip all files into a single directory of your choice.
  74.  
  75. Step  2)  Create a batch file that your BBS  will use to start the door. I use
  76.         PCBoard, and my file looks something like this:
  77.  
  78.         @echo off
  79.         cd\pcb\search
  80.         multsrch.exe c:\pcb\node1\door.sys /L
  81.         IF "%INPCB"=="Y" EXIT
  82.         %PCBDRIVE%
  83.         %PCBDIR%
  84.         board
  85.  
  86.         You  may call the file whatever you like, subject to restrictions that
  87.         may  be  enforced by your BBS  software. Mine is simply called SEARCH,
  88.         with no .BAT extension. Again, consult your manual.
  89.  
  90.         A  little explanation of the startup batch  file is in order here. The
  91.         first  line  simply  changes  to  the  directory  where  all  of  your
  92.         MultiSearch  Text Door program files are found. (Remember you put them
  93.         there  in  Step 1.) The second line  is  the name of the door program,
  94.         MULTSRCH.EXE,  followed by the complete path to your drop file and the
  95.         (optional)  log  file  switch.  Notice  that  the  drop  file  name is
  96.         specified.  If  you  are using PCBoard,  you  may also use the PCBoard
  97.         environment variables for the path to the drop file. Like this:
  98.  
  99.                         multsrch.exe %PCBDRIVE%%PCBDIR%\door.sys
  100.  
  101.         If you wish the program to log its activities, add "/L" after the path
  102.         to  the  drop  file like this:
  103.  
  104.                         multsrch.exe %PCBDRIVE%%PCBDIR%\door.sys /L
  105.  
  106.         The program will create MULTSRCH.LOG which will contain information on
  107.         door usage.  See the section below on "LOGGING ACTIVITY".
  108.  
  109.         Finally,   use   whatever  door   exiting   statements  your  software
  110.         recommends. Your startup file will undoubtedly look different, but you
  111.         get the general idea.
  112.  
  113.  
  114. Step  3)
  115.         Set  up  the category menu. If you  want to set up categories for your
  116.         documents  (and you should!) you must  first create MAIN.CFG using any
  117.         ASCII  text editor. Refer to  SAMPLE1.CFG for complete instructions on
  118.         the  contents of this file. This file is very simple and contains only
  119.         the  number of categories you wish to use and the description of each.
  120.  
  121.         If you do not want to use categories, but would rather have all of the
  122.         files  listed  in a single menu, you  can  skip this step. The program
  123.         will  provide your users with an option to list all files, so there is
  124.         really  no  reason not to set up  categories.  Also, you will not have
  125.         access  to  the door statistics or  file  properties display since the
  126.         menu option for these functions is available only through the category
  127.         menu.
  128.  
  129.         Note that the category configuration file MUST be called MAIN.CFG, and
  130.         MUST  reside in the program file  directory. The first category listed
  131.         will  be  category  1, the second category  2,  and  so forth. You may
  132.         define  a  maximum  of  20  categories  in  either  the  registered or
  133.         unregistered version.
  134.  
  135. Step  4)
  136.         Next  run  MULTEDIT.EXE to build the  document list menu. This program
  137.         will build the menu configuration file, MULTSRCH.CFG and add a default
  138.         entry.  Edit  this  entry with the  proper  information for your first
  139.         document. MULTEDIT.EXE is a very simple program that will let you add,
  140.         modify,   and  delete  document   entries,  change  your  registration
  141.         information,  etc.  You should use this  program each time you wish to
  142.         make modifications to your document menu. See MULTEDIT.DOC information
  143.         on this program.
  144.  
  145.         Alternatively  you  can  use  any  text  editor  to edit MULTSRCH.CFG.
  146.         Complete instructions for editing are included in SAMPLE2.CFG. Be sure
  147.         to  follow  these  carefully. Note that  no  lines  can be skipped and
  148.         comments  are not allowed. An explanation of  each line in the file is
  149.         included in SAMPLE2.CFG.  I don't recommend this because it's too easy
  150.         to make a mistake.
  151.  
  152.         If you have ANSI graphics files you would like to make available, they
  153.         must contain the ".ANS" file extension. Non-graphics users will not be
  154.         able to display these files.
  155.  
  156.         NOTE:  Using  categories is optional.  However, the program presents a
  157.         much   more  organized  environment  for  the  user  with  categorized
  158.         documents.  Without  the  category menu the  user  will see all of the
  159.         files  listed  together  in a single menu.  If  you  choose not to use
  160.